home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / rescue15.zip / RESCUE.DOC < prev    next >
Text File  |  1992-02-16  |  15KB  |  328 lines
  1.  
  2.                                  Rescue
  3.  
  4.                                   v1.5
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    You have received a call informing you that bombs have been planted in 
  21.    this 100 room hotel. You also determine that there are guests currently
  22.    in their rooms. Your mission is to RESCUE all the guests.
  23.  
  24.  
  25.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  26.          created in the directory you run the door from.
  27.  
  28.  
  29.  
  30.                               INSTALLATION
  31.                               ____________
  32.  
  33.  
  34.    Installation is fairly easy and straight-forward. The following steps and
  35.    examples should have you up and running in a very short period of time.
  36.    It is assumed that you are familiar with setting up DOORS on your system.
  37.    To this end, only examples of the configuration file and Door batch file
  38.    are described.
  39.  
  40.       1) Create a directory to hold all RESCUE files
  41.  
  42.       2) Unzip RESCUExx.ZIP into the the above directory
  43.  
  44.          NOTE: BRUN45.EXE is not included but is required !!!
  45.  
  46.       3) Create a configuration file, with a name of your choice, or
  47.          modify the supplied RESCUE.CFG file. A description follows:
  48.  
  49.             **                       Location of system file (See Below)
  50.             SUNRISE-80 BBS           Your BBS Name
  51.             Al                       Sysop's First nameAP
  52.  
  53.             Lawrence                 Sysop's Last Name
  54.  
  55.             00000000                 Registration Number
  56.  
  57.     !   #   2                        Maximum # of Games per day
  58.                                      (Sysop gets 99, Registered version ONLY)
  59.  
  60.             50                       Number of Top Score entries.
  61.                                      Minimum = 10, Maximum = 99.
  62.  
  63.         #   NONE                     Drive:\Path\Filename to contain the
  64.                                      Top Score Bulletin or enter NONE
  65.                                      for NO Bulletin creation.
  66.  
  67.         #   NONE                     Drive:\Path\Filename to contain the
  68.                                      Top Score Bulletin (Color) or enter NONE
  69.                                      for NO Bulletin creation.
  70.  
  71.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  72.                                      2 = Display ADOPT-A-DOOR message
  73.  
  74.         #   2                        Keyboard timeout value in Minutes
  75.  
  76.     !   #   0                        Time Allowed in Door
  77.                                      (Sysop = Time Remaining - REG. VERSION)
  78.  
  79.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  80.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  81.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  82.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  83.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  84.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  85.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  86.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  87.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  88.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  89.          
  90.     @   #   XXXX/YYYY                 Blackout Range  From/To
  91.     @   #   XXXX/YYYY                 Blackout Range  From/To
  92.     @   #   XXXX/YYYY                 Blackout Range  From/To
  93.     @   #   XXXX/YYYY                 Blackout Range  From/To
  94.     @   #   XXXX/YYYY                 Blackout Range  From/To
  95.  
  96.           ** = Replace with ONE of the following:
  97.  
  98. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  99. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  100. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  101.                                    (Note:DOOR.SYS must be in SAME directory)
  102. C:\BBS\DOOR.SYS                 <- For systems that support DOOR.SYS
  103. C:\BBS\DORINFOx.DEF             <- For QBBS/RBBS/RA. Replace x with Node #.
  104. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  105. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  106.  
  107.  
  108.            # = Requires registration to change to a different value.
  109.            ! = See "Plays per DAY/DOOR Time" Below
  110.            @ = See "Blackout Periods" Below
  111.  
  112.                NOTE: There are NO Blank Lines in the Config File!!
  113.  
  114.  
  115.  
  116.  
  117.       4) Create a batch file or modify the RESCUE file supplied. A
  118.          description of this file follows:
  119.  
  120.             ECHO off
  121.             cd\PCB\DOORS\RESCUE       Location of RESCUE files
  122.             RESCUE RESCUE.CFG         EXE filename and CFG filename (Name
  123.                                       used in creating file in #3 above)
  124.             CD\PCB
  125.             BOARD
  126.  
  127.  
  128.        5) When running in more than one node, be sure to supply a
  129.           different configuration name for each node (your choice of name).
  130.  
  131.  
  132.                           BLACKOUT PERIODS
  133.                           ________________
  134.  
  135.       Use the Blackout ranges option to define up to 5 time periods during
  136.       which you DO NOT want the Door to be played. If a caller tries to access 
  137.       the Door during the Blackout period, they will be shown a message that
  138.       contains ALL the Blackout periods you have defined, and to try the Door
  139.       at a later time.
  140.  
  141.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  142.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  143.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  144.  
  145.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  146.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  147.                    a Blackout range.
  148.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  149.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  150.  
  151.                    
  152.                           PLAYS Per DAY/DOOR Time
  153.                           _______________________
  154.  
  155.       Plays Per Day and Door Time can be controlled several ways:
  156.  
  157.       (1) You can use the Games Per Day, singular option, in the config
  158.           file above. This option, will affect ALL callers whose Security
  159.           Level is NOT defined in any of the 10 optional Security Level/
  160.           Plays Per Day entries in the config file.
  161.  
  162.       (2) You can use the Door Time, singular option, in the config file
  163.           above. This option, will affect ALL callers whose Security
  164.           Level is NOT defined in any of the 10 optional Security Level/
  165.           Plays Per Day/Door Time entries in the config file.
  166.  
  167.       (3) You can restrict the number of games a specific Security Level
  168.           will be allowed to play per day or REWARD specific Levels with 
  169.           more Plays Per Day. 
  170.  
  171.           Likewise, you can restrict the Play time for a specific Security
  172.           Level or REWARD specific Levels with more Door Time.
  173.  
  174.           These options are handled by the use of the 10 config 
  175.           entries (000=00/00). 
  176.           
  177.           The format of each entry is as follows:
  178.  
  179.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  180.                      where =  is a constant and MUST be included
  181.                      where YY is the # of games per day (must be 2 digits)
  182.                      where / is a constant and MUST be included
  183.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  184.           
  185.           If the callers Security Level is NOT defined, his/her Plays Per
  186.           Day and Door Time will be controlled by the values in items
  187.           (1) and (2), above, respectively..
  188.  
  189.           You may define up to 10 Security Levels. All unused entries must
  190.           be defined as   000=00/00
  191.         --------------------------------------------------------------------
  192.           Example: Suppose you had 3 Security Levels defined on your BBS as
  193.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  194.           wanted to set Plays Per Day as :     Subscriber=5
  195.                                            Visiting Sysop=2
  196.                                                   CoSysop=3
  197.                                                    Friend=10 
  198.           
  199.           and Door Time as follows:     Subscriber=30 minutes
  200.                                     Visiting Sysop=20 minutes
  201.                                            CoSysop=10 minutes 
  202.                                             Friend=remaining call time
  203.                                
  204.  
  205.           You would set the Individual "Games per Day" config entry to 1 and 
  206.           the individual "Door Time" to 5 minutes (these would be the 
  207.           default number of games and default Time for all Security Levels
  208.           other than 20,30 or 40... make them any number you want). Next you
  209.           would replace 4 of the Security Level entries as :  020=05/30                                               
  210.                                                               030=02/20
  211.                                                               040=03/10
  212.                                                               090=10/0
  213.  
  214.  
  215.  
  216.  
  217.                                COM Support
  218.                                ___________
  219.  
  220.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  221.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  222.       number after the configuration filename. Let's assume your Door is
  223.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  224.       passed to your Door would be:
  225.                                    FOOBAR FOOBAR.CFG /5
  226.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  227.       normally used with COM1. No /x parameter is needed for the standard
  228.       IRQ's.
  229.  
  230.  
  231.  
  232.                                ADOPT-A-DOOR
  233.                                ____________
  234.  
  235.     Having been a Sysop for a number of years, I have had my share of problems
  236.     and frustrations getting financial support for my board's upkeep. A fellow
  237.     Sysop left a message on my board, not long ago, about a concept that was
  238.     being used by several boards around the country.
  239.  
  240.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  241.     would be the same as sending in a donation, only this way it is earmarked
  242.     for registering a particular door. In a way, the user feels he/she is
  243.     "getting something in return". As a Door author I have decided to build
  244.     this concept into each of my Door programs. The concept replaces the
  245.     usual message "tell the Sysop to register this Door" we find in most
  246.     doors.
  247.  
  248.     If the Door is unregisterd then a message appears on the opening screen
  249.     to that effect. After finishing or suspending a game, a message screen
  250.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  251.     caller to contact the Sysop to find out if there is any further details
  252.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  253.     time, etc to callers that ADOPT-A-DOOR.
  254.  
  255.     If the Door has been registered, either by the Sysop or other callers,
  256.     the names of those contributors will be displayed in the closing screen.
  257.  
  258.     NOTE: If you want to display the names of the callers that contributed
  259.           to registering the Door, you must create an ASCII file called
  260.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  261.           the name(s) of the contributors (one on each line, maximum of 5
  262.           entries, each a maximum of 30 characters long). This file must be
  263.           saved, in ASCII format, and placed in the Door directory.
  264.  
  265.  
  266.  
  267.                               LEGALITIES
  268.                               __________
  269.  
  270.  
  271.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  272.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  273.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  274.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  275.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  276.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  277.       OR BREACH OF ANY WARRANTY.
  278.  
  279.  
  280.  
  281.  
  282.  
  283.                              DISTRIBUTION
  284.                              ____________
  285.  
  286.    You may make this file available for downloading from your BBS or you may
  287.    upload it to any BBS of your choice, provided that you do not make any
  288.    changes to the contents of the archive (ZIP file). The archive and its
  289.    individual contents may not be used by any service that charges any money
  290.    whatsoever, without the written permission of the author.
  291.  
  292.  
  293.  
  294.  
  295.  
  296.                              REGISTRATION
  297.                              ____________
  298.  
  299.    Registration and the subsequent insertion of the registration number into
  300.    your configuation file, allows for the display of your BBS name on the
  301.    opening and closing screen as well as the reduction of a delay built into
  302.    the opening screen display along with the ability to change certain
  303.    values in the configuration file.
  304.  
  305.    To register your copy of RESCUE, please fill out the registration form
  306.    (REGISTER.FRM) and mail it along with a small donation ($20,25,etc) to
  307.    the name and address on the form.
  308.  
  309.    Be sure to use the proper upper/lower case when filling in your name and
  310.    BBS name, as they MUST match the way you entered them in the configuration
  311.    file.             ^^^^
  312.  
  313.    Based upon information supplied on the registration form, I will pre-
  314.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  315.    up your registration number.
  316.  
  317.  
  318.  
  319.                                  MISC
  320.                                  ____
  321.  
  322.    The latest version of RESCUE and other fine SUNRISE DOOR programs are 
  323.    always available for download from SUNRISE-80 BBS.
  324.  
  325.    Remember, should you have any problems, questions or suggestions, be sure
  326.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, 
  327.    PCBHints, SYSops) or on SMARTNET (SN_Sysops).
  328.